Skip to content

docs: Document data structures - fixes #125.#157

Merged
rufuspollock merged 2 commits into
mainfrom
copilot/docs-data-structures
May 20, 2026
Merged

docs: Document data structures - fixes #125.#157
rufuspollock merged 2 commits into
mainfrom
copilot/docs-data-structures

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 22, 2026

Users had no way to know what fields and types to expect from the database before using the library — no reference existed for the output data model.

Changes

  • site/docs/data-structures.md (new) — field-level reference for every table MarkdownDB populates:

    • files_id, file_path, extension, url_path, filetype, metadata with types, descriptions, and a full JSON example
    • tagsname
    • file_tags — join table columns with foreign-key notes
    • linkslink_type, from, to
    • tasks — all 9 fields including inline-metadata fields (due, completion, created, start, scheduled, list, metadata) with a JSON example
    • ASCII schema diagram showing table relationships and cascade behaviour
  • site/docs/index.md — adds link to the new page under Guides

Example output documented

{
  "_id": "a3f5c2d1e4b6...",
  "file_path": "/content/blog/hello-world.md",
  "extension": "md",
  "url_path": "blog/hello-world",
  "filetype": null,
  "metadata": {
    "title": "Hello World",
    "tags": ["news", "tutorial"],
    "draft": false
  }
}

Copilot AI linked an issue Apr 22, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Add documentation for data structures used docs: Document data structures Apr 22, 2026
Copilot AI requested a review from rufuspollock April 22, 2026 20:37
@rufuspollock rufuspollock marked this pull request as ready for review May 20, 2026 17:22
Copilot AI and others added 2 commits May 20, 2026 19:22
Agent-Logs-Url: https://github.com/flowershow/markdowndb/sessions/395146b2-e234-41d1-9f3a-376f0fd60ce3

Co-authored-by: rufuspollock <180658+rufuspollock@users.noreply.github.com>
Agent-Logs-Url: https://github.com/flowershow/markdowndb/sessions/395146b2-e234-41d1-9f3a-376f0fd60ce3

Co-authored-by: rufuspollock <180658+rufuspollock@users.noreply.github.com>
@rufuspollock rufuspollock force-pushed the copilot/docs-data-structures branch from f092686 to 4bcdf1a Compare May 20, 2026 17:22
@rufuspollock rufuspollock changed the title docs: Document data structures docs: Document data structures - fixes #125. May 20, 2026
@rufuspollock rufuspollock merged commit aae230b into main May 20, 2026
2 checks passed
@rufuspollock rufuspollock deleted the copilot/docs-data-structures branch May 20, 2026 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Document Data Structures

2 participants